Fix and improve MovingWindow examples in docs - #368
Merged
leandro-lucarella-frequenz merged 3 commits intoApr 28, 2023
Conversation
leandro-lucarella-frequenz
commented
Apr 28, 2023
leandro-lucarella-frequenz
commented
Contributor
- Fix example formatting
- Add proper python markers to examples
- Improve examples formatting
The code block wasn't properly terminated, causing the generated documentation to be completely wrong, interpreting part of the documentation as code. Signed-off-by: Leandro Lucarella <leandro.lucarella@frequenz.com>
This makes the examples be properly syntax highlighted when rendered. Signed-off-by: Leandro Lucarella <leandro.lucarella@frequenz.com>
When each example is in its own `Example:` block with a proper title, they are also rendered in their own block with a nice title, which makes it much easier to read. Signed-off-by: Leandro Lucarella <leandro.lucarella@frequenz.com>
leandro-lucarella-frequenz
changed the title
MovingWindow docsMovingWindow examples in docs
Contributor
Author
|
The fix is for this:
And this is how it looks after the improvements in formatting:
|
mathias-baumann-frequenz
approved these changes
Apr 28, 2023
matthias-wende-frequenz
approved these changes
Apr 28, 2023
Contributor
Author
|
Ah, one catch, the final output doesn't say "Example: ..." but just "..." because then it renders with a custom title it doesn't add the "Example: " too, just the 🧪 icon. I tried putting |
Contributor
Author
|
So this is how the output with this PR looks like:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.